#region Copyright (c) 2006-2012 nHydrate.org, All Rights Reserved
// --------------------------------------------------------------------- *
//                           NHYDRATE.ORG                                *
//              Copyright (c) 2006-2012 All Rights reserved              *
//                                                                       *
//                                                                       *
// This file and its contents are protected by United States and         *
// International copyright laws.  Unauthorized reproduction and/or       *
// distribution of all or any portion of the code contained herein       *
// is strictly prohibited and will result in severe civil and criminal   *
// penalties.  Any violations of this copyright will be prosecuted       *
// to the fullest extent possible under law.                             *
//                                                                       *
// THE SOURCE CODE CONTAINED HEREIN AND IN RELATED FILES IS PROVIDED     *
// TO THE REGISTERED DEVELOPER FOR THE PURPOSES OF EDUCATION AND         *
// TROUBLESHOOTING. UNDER NO CIRCUMSTANCES MAY ANY PORTION OF THE SOURCE *
// CODE BE DISTRIBUTED, DISCLOSED OR OTHERWISE MADE AVAILABLE TO ANY     *
// THIRD PARTY WITHOUT THE EXPRESS WRITTEN CONSENT OF THE NHYDRATE GROUP *
//                                                                       *
// UNDER NO CIRCUMSTANCES MAY THE SOURCE CODE BE USED IN WHOLE OR IN     *
// PART, AS THE BASIS FOR CREATING A PRODUCT THAT PROVIDES THE SAME, OR  *
// SUBSTANTIALLY THE SAME, FUNCTIONALITY AS THIS PRODUCT                 *
//                                                                       *
// THE REGISTERED DEVELOPER ACKNOWLEDGES THAT THIS SOURCE CODE           *
// CONTAINS VALUABLE AND PROPRIETARY TRADE SECRETS OF NHYDRATE,          *
// THE REGISTERED DEVELOPER AGREES TO EXPEND EVERY EFFORT TO             *
// INSURE ITS CONFIDENTIALITY.                                           *
//                                                                       *
// THE END USER LICENSE AGREEMENT (EULA) ACCOMPANYING THE PRODUCT        *
// PERMITS THE REGISTERED DEVELOPER TO REDISTRIBUTE THE PRODUCT IN       *
// EXECUTABLE FORM ONLY IN SUPPORT OF APPLICATIONS WRITTEN USING         *
// THE PRODUCT.  IT DOES NOT PROVIDE ANY RIGHTS REGARDING THE            *
// SOURCE CODE CONTAINED HEREIN.                                         *
//                                                                       *
// THIS COPYRIGHT NOTICE MAY NOT BE REMOVED FROM THIS FILE.              *
// --------------------------------------------------------------------- *
#endregion
using System;
using System.ComponentModel;

namespace nHydrate.Generator.Common.GeneratorFramework
{
	public abstract class BaseModelObject : INHydrateModelObject
	{
		#region Class Members

		protected string _key = Guid.NewGuid().ToString();
		protected INHydrateModelObject _root;
		protected bool _dirty = false;
		protected bool _cancelUIEvents = false;
		protected INHydrateModelObjectController _controller = null;

		#endregion

		#region Constructor

		public BaseModelObject(INHydrateModelObject root)
		{
			_root = root;
		}

		#endregion

		#region Events

		public event PropertyChangedEventHandler PropertyChanged;
		public event System.EventHandler DirtyChanged;

		protected void OnPropertyChanged(object sender, PropertyChangedEventArgs e)
		{
			this.Dirty = true;

			//Cancel UI events if necessary
			if (!this.CancelUIEvents)
			{
				if (this.PropertyChanged != null)
					this.PropertyChanged(sender, e);
			}
		}

		protected void OnDirtyChanged(object sender, System.EventArgs e)
		{
			if (this.DirtyChanged != null)
				this.DirtyChanged(sender, e);
		}

		#endregion

		#region Property Implementations

		[Browsable(false)]
		public virtual INHydrateModelObjectController Controller
		{
			get { return _controller; }
			set { _controller = value; }
		}


		[Browsable(false)]
		public virtual INHydrateModelObject Root
		{
			get { return (INHydrateModelObject)_root; }
		}


		[Browsable(false)]
		public virtual string Key
		{
			get { return _key; }
		}

		[Browsable(false)]
		public virtual bool Dirty
		{
			get { return _dirty; }
			set
			{
				//if (_dirty != value)
				//{
				_dirty = value;
				this.OnDirtyChanged(this, new System.EventArgs());
				if ((this.Dirty) && (this.Root != null) && (this != this.Root))
					this.Root.Dirty = true;
				//}
			}
		}

		[Browsable(false)]
		public virtual bool CancelUIEvents
		{
			get { return _cancelUIEvents; }
			set { _cancelUIEvents = value; }
		}

		/// <summary>
		/// Resets the unique key
		/// </summary>
		/// <param name="newKey"></param>
		public void ResetKey(string newKey)
		{
			if (string.IsNullOrEmpty(newKey))
				throw new Exception("The key value must have a value!");
			_key = newKey;
		}

		#endregion

		#region IXMLable Members

		public abstract void XmlAppend(System.Xml.XmlNode node);
		public abstract void XmlLoad(System.Xml.XmlNode node);

		#endregion

	}
}